gempy.create_geomodel¶
- gempy.create_geomodel(*, project_name: str = 'default_project', extent: list | ndarray | None = None, resolution: list | ndarray | None = None, refinement: int = 1, structural_frame: StructuralFrame | None = None, importer_helper: ImporterHelper | None = None) GeoModel[source]¶
Initializes and returns a GeoModel instance with specified parameters.
- Parameters:
project_name (str, optional) – The name of the project. Defaults to ‘default_project’.
extent (Union[List, np.ndarray], optional) – The 3D extent of the grid. Must be provided if resolution is specified. Defaults to None.
resolution (Union[List, np.ndarray], optional) – The resolution of the grid. If None, an octree grid will be initialized. Defaults to None.
refinement (int, optional) – The level of refinement for the octree grid. Defaults to 1.
structural_frame (StructuralFrame, optional) – The structural frame of the GeoModel. Either this or importer_helper must be provided. Defaults to None.
importer_helper (ImporterHelper, optional) – Helper object for importing structural elements. Either this or structural_frame must be provided. Defaults to None.
- Returns:
The initialized GeoModel object.
- Return type:
- Raises:
ValueError – If neither structural_frame nor importer_helper is provided.
